Cancelar pedido

Cancela un pedido del comercio autenticado. Es la forma servidor a servidor de Cancelar pedido en Storefront: la misma validación, el mismo estado terminal y la misma interrupción del fulfillment. Fire spark actualiza los estados del pedido y del fulfillment, detiene un workflow de fulfillment en curso y avisa a las integraciones conectadas.

Requiere un access token con el scope orders:write. Consulta Token para obtener un token.

El estado resultante depende de si el pago ya fue capturado:

Pago	`status` del pedido	`fulfillment_status`
Sin captura	`VOIDED`	`VOIDED`
Capturado	`REVERSED`	`REVERSED`

Los tenders sin cobrar se anulan, así que payment_status queda en CANCELLED. Los tenders capturados se reembolsan, así que payment_status queda en REFUNDED. payment_status se deriva de los tenders.

La restricción de siguientes estados del fulfillment no cambia. Un avance del workflow a VOIDED se sigue rechazando cuando VOIDED no está entre los siguientes estados del nodo actual. La cancelación elige VOIDED o REVERSED según la captura.

La cancelación se rechaza cuando el pedido ya está fulfilled. Reembolsa un pedido fulfilled desde el canal que lo creó.

Parámetros de ruta

Parámetro	Requerido	Descripción
`id`	Sí	Identificador externo del pedido

Solicitud

Sin cuerpo. El id del pedido va en la ruta.

curl -X POST "https://firespark.cloud/api/admin/v1/orders/ord-48291/cancel" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Respuesta

Devuelve 200 con el pedido cancelado en data.

{
  "data": {
    "id": "ord-48291",
    "status": "VOIDED",
    "fulfillment_status": "VOIDED",
    "payment_status": "CANCELLED"
  }
}

{
  "data": {
    "id": "ord-48291",
    "status": "REVERSED",
    "fulfillment_status": "REVERSED",
    "payment_status": "REFUNDED"
  }
}

Respuestas de error

Estado	Descripción
`401`	Access token ausente o inválido
`403`	Al token le falta el scope `orders:write`
`404`	Pedido no encontrado
`422`	El pedido ya está fulfilled, o no puede cancelarse en su estado actual

Documentación de API

Endpoints

Guías

Recursos

Parámetros de ruta

Solicitud

Respuesta

Respuestas de error

​Parámetros de ruta

​Solicitud

​Respuesta

​Respuestas de error

Parámetros de ruta

Solicitud

Respuesta

Respuestas de error